Allow users to configure custom link component#563

Open

virginiacc wants to merge 6 commits into

mainfrom

vcc-link-context

Contributor

virginiacc commented May 4, 2026 •

edited

Loading

This PR adds the ability for users to globally configure the DSR to use their router's link component.

Changes

Adds DSR Context that accepts a LinkComponent value. Defaults to a BaseLink component that outputs an anchor element.
Updates Link component to output the LinkComponent value from the DSR context
Updates Breadcrumbs component to use Link instead of anchor element
Removes react-router dependency

Breaking changes

Updates Link, Header, SecondaryNav, and Breadcrumb components to use to prop instead of href for compatibility with external link components

How to test this PR

Wrap app in DSR context provider and pass it a custom link component:

<YourRouterProvider>
  <DSRContext value={{LinkComponent: YourLinkComponent}} >
    // App code
  </DSRContext>

Update instances of Link, Breadcrumbs, SecondaryNav, and Header to use to instead of href
Check that the component passed in the context is output anywhere the Link component is used

To do

Add documentation

virginiacc added 4 commits

April 30, 2026 15:26


          Add ability to configure DSR to use router link component.

ab781e1


          Link test updates

6d154d8


          Revert link icon changes.

553a1f6


          Restore icon test

69dd2ed

github-actions Bot commented May 4, 2026 •

edited

Loading

PR Preview Action v1.8.1
🚀 View preview at https://cfpb.github.io/design-system-react/pr-previews/pr-563/
Built to branch `gh-pages` at 2026-05-06 16:58 UTC. Preview will be ready when the GitHub Pages deployment is complete.

flacoman91 reviewed

View reviewed changes

src/components/Link/link.test.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx

flacoman91 reviewed

View reviewed changes

src/components/Breadcrumb/breadcrumb.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/components/Link/base-link.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/components/Link/link.test.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/components/Link/link.test.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/components/Link/link.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx Outdated

flacoman91 reviewed

View reviewed changes

src/context/dsr-context.tsx Outdated

virginiacc and others added 2 commits

May 6, 2026 08:43


          Use relative imports

1e8ba7d

Co-authored-by: Richard Dinh <1038306+flacoman91@users.noreply.github.com>


          Remove react-router dependency and update DSRContext imports and prov…

bbf6a8c

…ider interface.

virginiacc marked this pull request as ready for review

May 6, 2026 17:03

virginiacc requested review from anselmbradford, billhimmelsbach, contolini and natalia-fitzgerald as code owners

May 6, 2026 17:03

virginiacc requested a review from flacoman91

May 6, 2026 17:04

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

contolini Awaiting requested review from contolini contolini is a code owner

billhimmelsbach Awaiting requested review from billhimmelsbach billhimmelsbach is a code owner

natalia-fitzgerald Awaiting requested review from natalia-fitzgerald natalia-fitzgerald is a code owner

anselmbradford Awaiting requested review from anselmbradford anselmbradford is a code owner

flacoman91 Awaiting requested review from flacoman91 flacoman91 is a code owner

At least 1 approving review is required to merge this pull request.

Labels

None yet